Beginnen met het testen van de DocuGenerate API is een fluitje van een cent met Postman, een krachtige tool voor API-ontwikkeling en -testen. Postman vereenvoudigt het proces van het doen van API-verzoeken, het inspecteren van antwoorden, en het stroomlijnen van uw testworkflow.
In dit artikel doorlopen we het proces met de Job Offer Letter uit de blogpost 4 Manieren om Aanbiedingsbrieven in Bulk te Genereren om meerdere documenten te genereren.
Wat is Postman?
Postman is een uitgebreide API-ontwikkelomgeving waarmee u API’s kunt ontwerpen, testen en documenteren. Het biedt een gebruiksvriendelijke interface voor het versturen van HTTP-verzoeken, het organiseren van uw API-eindpunten, en het beheren van uw testomgevingen. Of u nu ontwikkelaar, tester, of onderdeel van een DevOps-team bent, Postman kan uw API-test- en ontwikkelprocessen verbeteren.
De Postman-collectie importeren
Om het testproces te vereenvoudigen, importeert u de DocuGenerate API Collection in Postman. Na het importeren van de collectie zou u de eindpunten Template en Document vermeld moeten zien, zoals in de volgende afbeelding:
Authenticeren met de API-sleutel
Om te beginnen met testen met de DocuGenerate API in Postman, is het essentieel om de sectie Authorization in de Postman-collectie in te stellen.
Hoewel dit artikel de demosleutel 491c000c5fad32ed7787005b0723ad55 gebruikt, wordt aanbevolen deze te vervangen door uw unieke API-sleutel voor daadwerkelijk gebruik. U kunt uw individuele API-sleutel ophalen via de pagina Settings na het inloggen bij DocuGenerate.
Documenten genereren
Navigeer naar het eindpunt Document / Generate Document binnen de Postman-collectie en geef de parameter template_id op. Als u een sjabloon heeft gemaakt met de Job Offer Letter, gebruikt u de ID van dat sjabloon.
Zorg er ook voor dat u form-data selecteert als het body-type, zodat het POST-verzoek het content type multipart/form-data gebruikt, wat nodig is voor een succesvolle API-aanroep.
Voer voor de parameter data de dataset in die bedoeld is voor documentgeneratie. Het verwachte formaat is een array van JSON-objecten, waarbij elk JSON-object sleutels heeft die overeenkomen met de merge-tags van het sjabloon.
Hoewel de parameter output_format optioneel is, met .docx als standaardwaarde, heeft u de flexibiliteit om de documenten te genereren in alternatieve formaten zoals .pdf, .doc of .odt, zoals beschreven in de API-referentie.
Na verwerking retourneert de API een JSON-object voor het nieuw gemaakte document. Binnen het antwoordobject biedt het veld document_uri een link naar het gegenereerde PDF:
{
"filename": "Job Offer Letter.pdf",
"created": 1696365915580,
"data_length": 20,
"name": "Job Offer Letter",
"format": ".pdf",
"template_id": "ZtHBhb9jLh6TcZuaVteI",
"document_uri": "https://storage.googleapis.com/docugenerate.appspot.com/documents/2GhuZ9GIDbFAl2PdEeAr/Job%20Offer%20Letter.pdf?GoogleAccessId=firebase-adminsdk-4i7q5%40docugenerate.iam.gserviceaccount.com&Expires=1834037410&Signature=J2Y7g%2Be3Xr7CvRTfskT3v8%2BGMS6tfFzuEDwvIPM7zH3xQGHcEekos9s7hQTDjeYbYKrJngxhVeOhAAbKhLAahZqwrKBSyuyoXhCMiwiS0Uhfpe8W9a%2BZ973OlBNnOpxZ18DxDwZPmYNq4afFKuxaaNUdYFUXE3RiG5Fs7KOJjNZ8%2FDcSHVm1%2FITzamT96SdYm6KTLNEiuS0bjYaJZ97hAT7DxG5dMRinIZQ1pkRPjXrz8U%2Fe%2BdVeCWMVps6HzONECCM4ismU26waadXiWcsqsd9qi9STAsnc7caaEQASLoZkO6Y0wJXcJao%2FBsby1P7OY2XJx%2F8NyCgzcFWscObgbw%3D%3D",
"id": "7JxcR3Q1EVKqljsTvHqc"
}
Door Postman te gebruiken, kunt u uw testproces stroomlijnen, potentiële problemen identificeren, en zorgen voor een soepele integratie van DocuGenerate in uw applicaties.